Node / meshtastic / Meshtastic-Android / files / .github / workflows / docs-deploy.yml

Displaying Raw • Download

Tff7b72nameTb4b4b4: Ta5d6ffDeployTa5d6ff Ta5d6ffDocumentation

Tff7b72onTb4b4b4:

Tff7b72pushTb4b4b4:

Tff7b72branchesTb4b4b4: Tb4b4b4[Te6edf3mainTb4b4b4]

Tff7b72pathsTb4b4b4:

T8b949e# Dokka sources (KDoc in source files)

Tb4b4b4- Ta5d6ff'Ta5d6ffandroidApp/src/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffcore/**/src/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6fffeature/**/src/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffdesktopApp/src/**Ta5d6ff'

T8b949e# Docs site sources

Tb4b4b4- Ta5d6ff'Ta5d6ffdocs/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6fffeature/docs/**Ta5d6ff'

T8b949e# Build infrastructure

Tb4b4b4- Ta5d6ff'Ta5d6ffbuild-logic/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffbuild.gradle.ktsTa5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffsettings.gradle.ktsTa5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ff.github/workflows/docs-deploy.ymlTa5d6ff'

Tff7b72workflow_dispatchTb4b4b4:

Tff7b72permissionsTb4b4b4:

Tff7b72contentsTb4b4b4: Ta5d6ffread

Tff7b72pagesTb4b4b4: Ta5d6ffwrite

Tff7b72id-tokenTb4b4b4: Ta5d6ffwrite

Tff7b72concurrencyTb4b4b4:

Tff7b72groupTb4b4b4: Ta5d6ffpages

Tff7b72cancel-in-progressTb4b4b4: Ta5d6fftrue

Tff7b72jobsTb4b4b4:

Tff7b72buildTb4b4b4:

Tff7b72ifTb4b4b4: Ta5d6ffgithub.repositoryTa5d6ff Ta5d6ff==Ta5d6ff Ta5d6ff'meshtastic/Meshtastic-Android'

Tff7b72runs-onTb4b4b4: Ta5d6ffubuntu-24.04

Tff7b72timeout-minutesTb4b4b4: Ta5d6ff45

Tff7b72stepsTb4b4b4:

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffCheckout

Tff7b72usesTb4b4b4: Ta5d6ffactions/checkout@v7.0.1

Tff7b72withTb4b4b4:

Tff7b72submodulesTb4b4b4: Ta5d6fftrue

Tff7b72fetch-depthTb4b4b4: Ta5d6ff0

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffGradleTa5d6ff Ta5d6ffSetup

Tff7b72usesTb4b4b4: Ta5d6ff./.github/actions/gradle-setup

Tff7b72withTb4b4b4:

Tff7b72gradle_encryption_keyTb4b4b4: Ta5d6ff${{Ta5d6ff Ta5d6ffsecrets.GRADLE_ENCRYPTION_KEYTa5d6ff Ta5d6ff}}

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffSetupTa5d6ff Ta5d6ffRuby

Tff7b72usesTb4b4b4: Ta5d6ffruby/setup-ruby@v1

Tff7b72withTb4b4b4:

Tff7b72ruby-versionTb4b4b4: Ta5d6ff'Ta5d6ff4.0.6Ta5d6ff'

Tff7b72bundler-cacheTb4b4b4: Ta5d6fftrue

Tff7b72working-directoryTb4b4b4: Ta5d6ffdocs

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffGenerateTa5d6ff Ta5d6ffDocsTa5d6ff Ta5d6ffSite

Tff7b72runTb4b4b4: Ta5d6ff./gradlewTa5d6ff Ta5d6ffgenerateDocsBundleTa5d6ff Ta5d6ffvalidateDocsBundleTa5d6ff Ta5d6ffpublishDocsSiteTa5d6ff Ta5d6ff-Pdocs.channel=rootTa5d6ff Ta5d6ff-Pci=true

T8b949e# Dokka (Gradle) and Jekyll (Ruby) are independent — Dokka's output is only

T8b949e# copied in afterwards — so run them concurrently to overlap the two slowest

T8b949e# steps (~10 min Dokka vs ~5 min Jekyll) instead of summing them (~16 -> ~11 min).

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffBuildTa5d6ff Ta5d6ffDokkaTa5d6ff Ta5d6ff+Ta5d6ff Ta5d6ffJekyllTa5d6ff Ta5d6ffconcurrently

Tff7b72runTb4b4b4: Tb4b4b4|

Tff7b72set -euo pipefail

Tff7b72BUNDLE_GEMFILE=docs/Gemfile bundle exec jekyll build \

Tff7b72--source build/_site \

Tff7b72--destination build/jekyll_site \

Tff7b72--baseurl /${{ github.event.repository.name }} &

Tff7b72jekyll_pid=$!

Tff7b72./gradlew dokkaGeneratePublicationHtml --no-configuration-cache

Tff7b72wait "$jekyll_pid"

Tff7b72touch build/jekyll_site/.nojekyll

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffAssembleTa5d6ff Ta5d6ffPagesTa5d6ff Ta5d6ffartifact

Tff7b72runTb4b4b4: Ta5d6ffcpTa5d6ff Ta5d6ff-rTa5d6ff Ta5d6ffbuild/dokka/htmlTa5d6ff Ta5d6ffbuild/jekyll_site/api T8b949e# Dokka HTML -> /api

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffUploadTa5d6ff Ta5d6ffPagesTa5d6ff Ta5d6ffArtifact

Tff7b72usesTb4b4b4: Ta5d6ffactions/upload-pages-artifact@v5

Tff7b72withTb4b4b4:

Tff7b72pathTb4b4b4: Ta5d6ffbuild/jekyll_site/

Tff7b72deployTb4b4b4:

Tff7b72ifTb4b4b4: Ta5d6ffgithub.repositoryTa5d6ff Ta5d6ff==Ta5d6ff Ta5d6ff'meshtastic/Meshtastic-Android'

Tff7b72needsTb4b4b4: Ta5d6ffbuild

Tff7b72runs-onTb4b4b4: Ta5d6ffubuntu-24.04-arm

Tff7b72timeout-minutesTb4b4b4: Ta5d6ff15

Tff7b72environmentTb4b4b4:

Tff7b72nameTb4b4b4: Ta5d6ffgithub-pages

Tff7b72urlTb4b4b4: Ta5d6ff${{Ta5d6ff Ta5d6ffsteps.deployment.outputs.page_urlTa5d6ff Ta5d6ff}}

Tff7b72stepsTb4b4b4:

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffDeployTa5d6ff Ta5d6fftoTa5d6ff Ta5d6ffGitHubTa5d6ff Ta5d6ffPages

Tff7b72idTb4b4b4: Ta5d6ffdeployment

Tff7b72usesTb4b4b4: Ta5d6ffactions/deploy-pages@v5